VS_ShowNtx()         Index "gas guage"                                    CHG

Description:

  VS_ShowNtx() provides the programmer with a non-screen destructive
  "gas guage" type of chart to show the user what percentage of the
  index operation is complete.

Syntax:     

  l_Success = VS_ShowNtx( c_Name, c_Key, [c_Type], [l_Unique])

Pass:       

  c_NtxName is a character expression representing the name of the
  index file to create.  i.e. "MYINDEX"

  c_Key is a character expression that represents the index key in
  textual form.

  c_Type is a optional character expression that should be set to
  one following values... C for Character, N for Numeric, D for Date.
  The default value for c_Type is "C"

  l_Unique is a optional logical expression that should be set to
  .T. if you want to create a "UNIQUE" index.  If omitted or .F.,
  VS_ShowNtx() will create a "non-UNIQUE" index.

Return:     

  l_Success is a logical expression that will be set to .T. if
  successful, otherwise .F.

Notes:      


Example:    

  USE CLIENT ALIAS CLIENT
  IF .NOT. FILE("CLIENT1.NTX")
     VS_SHOWNTX("CLIENT1","ZIP_CODE+ACCT_NMBR")
  ENDIF
  IF .NOT. FILE("CLIENT2.NTX")
     VS_SHOWNTX("CLIENT2","SLSPERSON")
  ENDIF
  SET INDEX TO CLIENT1, CLIENT2

Usage:      

  One of the biggest disadvantages of Clipper is the inability to show
  the progress of an index operation. While it can be argued that the
  hard drive access light is sufficient to tell the user that something
  is happening, a far greater number of users will argue to the
  contrary.  In fact, several users have been known to turn the machine
  off while in the middle of a large index operation.  VS_SHOWNTX()
  provides a user-friendly "gas-guage" type of display telling the user
  exactly how things are progressing.

  VS_SHOWNTX() is a substitution for the Clipper "INDEX ON" command.  It
  acts EXACTLY the same as "INDEX ON" in that all other index files
  currently open for the database are closed.